[docs] Document Show tunnel URLs command for Dev Tunnels integration - #1492
[docs] Document Show tunnel URLs command for Dev Tunnels integration#1492aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
There was a problem hiding this comment.
Pull request overview
Updates the Dev Tunnels integration documentation to cover the new dashboard discoverability features for tunnel URLs (highlighted properties + a Show tunnel URLs command) introduced in microsoft/aspire#16842.
Changes:
- Added a new Show tunnel URLs section describing the highlighted Tunnel/Inspect/Local endpoint URL properties in the dashboard.
- Documented the Show tunnel URLs dashboard command and its enabled-only-when-running behavior.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| While the dev tunnel is running, the Aspire dashboard publishes the public tunnel URL, the inspect URL, and the local endpoint URL as highlighted properties on the tunnel port resource's property pane so they're discoverable at a glance. | ||
|
|
||
| You can also select the highlighted **Show tunnel URLs** command from the port resource's command menu in the dashboard. This opens a message box listing: |
| You can also select the highlighted **Show tunnel URLs** command from the port resource's command menu in the dashboard. This opens a message box listing: | ||
|
|
||
| - **Tunnel URL** — the public dev tunnel URL for the port | ||
| - **Inspect URL** — the [dev tunnels inspect](https://learn.microsoft.com/azure/developer/dev-tunnels/inspect-tunneling-http-requests) URL for viewing tunneled HTTP traffic |
David Pine (IEvangelist)
left a comment
There was a problem hiding this comment.
Automated docs-accuracy review — Phase A (claims) + Phase B (doc-tester)
Phase A source of truth: microsoft/aspire @ release/13.5, SHA 8ab6999850d96e0023670799edbd4bdc245ad63c (authoritative remote tip; matches this PR's base branch).
Reviewed head SHA: 90f0d1e38028a08857cb064929f55bb78e798512.
Phase A — claims: 4 non-narrative claims extracted → 0 verified, 0 verified-with-nuance, 4 unverifiable, 0 contradicted.
Phase B — doc-tester: 1 page exercised (/integrations/devtools/dev-tunnels/, anchor #show-tunnel-urls) → 0 critical, 0 warnings, 0 knowledge gaps.
Verdict: COMMENT.
⚠️ Key finding — the documented feature isn't on the branch this PR targets
This PR targets release/13.5, so microsoft/aspire's release/13.5 branch (8ab6999) is the source of truth. The entire "Show tunnel URLs" feature — the highlighted command, the message box, and the highlighted tunnel/inspect/local URL properties — is not present on release/13.5. On that branch, src/Aspire.Hosting.DevTunnels/DevTunnelResourceBuilderExtensions.cs registers no .WithCommand(...) on the dev tunnel port resource and marks no properties as highlighted; it only surfaces the tunnel and inspect URLs via .WithUrls(...) (the inspect URL uses DisplayLocation = UrlDisplayLocation.DetailsOnly).
The feature does exist on microsoft/aspire main (0be40cb992247cbe8ed7bb6d12069947e8338f14), where the doc's description is accurate. So this reads as a branch-targeting / not-yet-backported issue rather than a factual error in the prose: the content correctly documents main, but it's being added to a release branch that doesn't ship the feature yet.
Recommendation: confirm the show-tunnel-urls command has been (or will be) backported to microsoft/aspire release/13.5 before merging this into the release/13.5 docs, or retarget the PR to the docs branch that corresponds to the release carrying this feature. All four claims below are marked unverifiable strictly against the target branch — none are contradicted by the source (the feature is simply absent there).
Phase A — Claim verification
All four non-narrative claims share the single root cause above (feature absent on release/13.5). Evidence that it is present on main (0be40cb, context only — not the source of truth for this PR) is included per claim.
- C1 — "the dashboard publishes the public tunnel URL, the inspect URL, and the local endpoint URL as highlighted properties on the tunnel port resource's property pane."
unverifiableonrelease/13.5(no highlighted properties; URLs surfaced viaWithUrls). Onmain:GetUrlProperties(...)buildsTunnelUrl/InspectUrl/LocalEndpointUrlResourcePropertySnapshots each withIsHighlighted = true. - C2 — "select the highlighted Show tunnel URLs command from the port resource's command menu."
unverifiableonrelease/13.5(noWithCommand). Onmain:DevTunnelResourceBuilderExtensions.cs.WithCommand(ShowTunnelUrlsCommandName /* "show-tunnel-urls" */, …, new CommandOptions { IsHighlighted = true, … }). - C3 — "This opens a message box listing: Tunnel URL, Inspect URL, Local endpoint URL."
unverifiableonrelease/13.5. Onmain:ShowTunnelUrlsAsync(...)callsinteractionService.PromptMessageBoxAsync(...), with the three labeled entries fromGetUrlProperties. - C4 — "The Show tunnel URLs command is only enabled once the tunnel port is running and its public URL has been allocated."
unverifiableonrelease/13.5. Onmain: the command'sUpdateStatereturnsEnabledonly wheninteractionService.IsAvailable && State == Running && portResource.LastKnownStatus?.PortUri is not null, elseDisabled.
The Inspect URL external link (learn.microsoft.com/azure/developer/dev-tunnels/inspect-tunneling-http-requests) is outside microsoft/aspire and out of scope for source verification; Phase B confirmed it renders as a link with a valid href.
Phase B — Doc-tester results
Report reproduced verbatim from the doc-tester skill run (blind to source; navigation via Playwright; served locally with pnpm dev). Note: Phase B tests only whether the added prose renders and reads well — it cannot detect the branch-mismatch above, which is a Phase A (source-of-truth) finding.
Documentation Test Report
Focus Area: PR #1492 Dev Tunnels "Show tunnel URLs" subsection
Date: 2026-08-14
Tester: doc-tester agent
Served Base URL:http://localhost:4321/
Served Head SHA:90f0d1e38028a08857cb064929f55bb78e798512Routes Exercised:
http://localhost:4321/integrations/devtools/dev-tunnels/http://localhost:4321/integrations/devtools/dev-tunnels/#show-tunnel-urlsScreenshots:
pr1492-show-tunnel-urls.pngSummary
Category Passed Failed Warnings Content Accuracy 4 0 0 Code Examples 0 0 0 CLI Commands 0 0 0 Links 2 0 0 Critical Issues
None.
Warnings
None.
Passed Checks
- The Dev Tunnels page loaded successfully.
- The "Show tunnel URLs" subsection appears in the "On this page" navigation.
- Clicking "Show tunnel URLs" navigated to
#show-tunnel-urls.- The subsection rendered in the expected position before "Service discovery integration."
- The intro paragraph clearly explains the highlighted dashboard properties.
- The highlighted Show tunnel URLs command text rendered clearly.
- The bulleted list rendered with bold labels for Tunnel URL, Inspect URL, and Local endpoint URL.
- The em dash rendered correctly as
—.- The "dev tunnels inspect" external link rendered with href
https://learn.microsoft.com/azure/developer/dev-tunnels/inspect-tunneling-http-requests.- The Note callout rendered correctly and explains the command enablement condition.
- No broken anchor, duplicate content, or formatting issue was observed in the tested section.
Recommendations
- Priority fixes: None.
- Documentation gaps: None found in the tested section.
- Product issues: None discovered from blind documentation testing.
Knowledge Gaps
None.
Automated review: Phase A verifies claims against microsoft/aspire source at the release-branch SHA; Phase B validates the rendered docs as a new user via the doc-tester skill. This is a non-blocking COMMENT; the key item is confirming the feature ships in the targeted release branch.
|
|
||
| ### Show tunnel URLs | ||
|
|
||
| While the dev tunnel is running, the Aspire dashboard publishes the public tunnel URL, the inspect URL, and the local endpoint URL as highlighted properties on the tunnel port resource's property pane so they're discoverable at a glance. |
There was a problem hiding this comment.
Source-of-truth check (Phase A): this feature isn't on release/13.5, the branch this PR targets.
Verified against microsoft/aspire release/13.5 @ 8ab6999850d96e0023670799edbd4bdc245ad63c. On that branch, src/Aspire.Hosting.DevTunnels/DevTunnelResourceBuilderExtensions.cs registers no .WithCommand(...) on the dev tunnel port resource and marks no properties as highlighted — the port only exposes the tunnel/inspect URLs via .WithUrls(...) (inspect is DisplayLocation = UrlDisplayLocation.DetailsOnly). So, against the branch this PR targets, all of the following are unverifiable:
- the "highlighted properties" on the property pane (this paragraph),
- the highlighted Show tunnel URLs command,
- the message box listing Tunnel URL / Inspect URL / Local endpoint URL,
- the "only enabled once the tunnel port is running and its public URL has been allocated" note.
The feature does exist on microsoft/aspire main (0be40cb992247cbe8ed7bb6d12069947e8338f14) — .WithCommand("show-tunnel-urls", …, IsHighlighted = true), ShowTunnelUrlsAsync → PromptMessageBoxAsync, and GetUrlProperties(...) with IsHighlighted = true on the three URL properties — where this description is accurate.
Please confirm show-tunnel-urls has been (or will be) backported to release/13.5 before merging here, or retarget this to the docs branch matching the release that carries the feature. (Not a prose error — the content correctly documents main.)
|
This feature is not for 13.5 it's for 13.6, will retarget the PR. Thanks! |
Adam Ratzman (adamint)
left a comment
There was a problem hiding this comment.
This PR looks like it was opened with the wrong ancestry. GitHub is comparing 39,854 additions and 11,666 deletions across hundreds of files, while the head commit only adds 15 lines to dev-tunnels.mdx. Could you recreate or retarget it from pre/13.6 so the review contains only the intended docs change?
…operties Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
90f0d1e to
b8fca59
Compare
David Pine (IEvangelist)
left a comment
There was a problem hiding this comment.
Docs-accuracy review — automated (Phase A: claims vs source · Phase B: doc-tester)
Phase A source of truth: microsoft/aspire @ main — SHA ac4f6515aef75c36ddb4f27a3addd7751591a84e
Reviewed head SHA: b8fca591da4d0a370d13239b455199407011676b
Claims extracted: 4 · ✅ verified: 4 ·
Phase B (doc-tester): /integrations/devtools/dev-tunnels/ (anchor #show-tunnel-urls) · 🔴 critical: 0 · 🟡 warnings: 0 · 0 knowledge gaps
✅ Update since my previous review — the earlier finding is resolved
My prior review (head
90f0d1e) was against a revision that targetedrelease/13.5, where the "Show tunnel URLs" feature does not exist, so all four claims wereunverifiablethere. This revision retargets the PR topre/13.6and rebases.microsoft/aspirehas nopre/13.6orrelease/13.6branch, so per the source-of-truth fallback I verified againstmain(ac4f6515) — the 13.6 development line where this feature lives. Onmain, all four claims verify exactly.One thing to confirm before merge (why this is
COMMENT, notAPPROVE): because the PR's base (pre/13.6) has no matchingmicrosoft/aspirebranch, the source of truth is a fallback tomain. Please confirmpre/13.6is the docs branch that will ship the release carryingshow-tunnel-urls(it's onmain, i.e. the upcoming 13.6 line) so the section lands with — not ahead of — the feature.
Phase A — Claim verification
All 4 non-narrative claims verified against microsoft/aspire main (ac4f6515). No contradicted or unverifiable claims, so there are no inline comments.
✅ Verified claims (4) with evidence
| # | Claim | Verdict | Evidence (microsoft/aspire @ ac4f6515, src/Aspire.Hosting.DevTunnels/) |
|---|---|---|---|
| 1 | The dashboard publishes the tunnel URL, inspect URL, and local endpoint URL as highlighted properties on the port resource's property pane. | ✅ verified | DevTunnelResourceBuilderExtensions.cs:726-733 — on Running, PublishUpdateAsync appends GetUrlProperties(portResource) to the snapshot Properties. GetUrlProperties (:833-868) builds TunnelUrl/InspectUrl/LocalEndpointUrl ResourcePropertySnapshots each with IsHighlighted = true (:845,:854,:863). Labels Tunnel URL / Inspect URL / Local endpoint URL (Resources/MessageStrings.resx). |
| 2 | A highlighted Show tunnel URLs command appears in the port resource's command menu. | ✅ verified | DevTunnelResourceBuilderExtensions.cs:606-626 — .WithCommand(DevTunnelPortResource.ShowTunnelUrlsCommandName, MessageStrings.ShowTunnelUrlsCommandDisplayName, …) with IsHighlighted = true (:615) and Visibility = ResourceCommandVisibility.UI. Constant ShowTunnelUrlsCommandName = "show-tunnel-urls" (DevTunnelResource.cs:55); display name Show tunnel URLs (MessageStrings.resx). |
| 3 | Selecting it opens a message box listing Tunnel URL, Inspect URL, Local endpoint URL. | ✅ verified | ShowTunnelUrlsAsync (:798-831) → interactionService.PromptMessageBoxAsync(ShowTunnelUrlsCommandResultHeading, markdown, …). markdown (:812-814) lists each p.DisplayName from GetUrlProperties, i.e. the three labels above. Heading Dev tunnel URLs. |
| 4 | The command is only enabled once the port is running and its public URL has been allocated. | ✅ verified | UpdateState (:617-625) returns Enabled only when interactionService.IsAvailable && ResourceSnapshot.State?.Text == KnownResourceStates.Running && portResource.LastKnownStatus?.PortUri is not null, else Disabled. |
The Inspect URL external link (learn.microsoft.com/azure/developer/dev-tunnels/inspect-tunneling-http-requests) points outside microsoft/aspire and is out of scope for source verification; Phase B confirmed it renders as a link with a valid href.
Phase B — Doc-tester results (blind user; no microsoft/aspire source consulted)
Focus area: /integrations/devtools/dev-tunnels/ — the added Show tunnel URLs section.
Routes / actions exercised this run:
https://aspire.dev/integrations/devtools/dev-tunnels/— loaded (HTTP 200, title "Dev Tunnels integration | Aspire"). Confirmed the endpoint-exposure bullet list ("…theadminendpoint of theapiproject that requires authentication") is immediately followed by the Service discovery integration heading — the exact insertion point for the new### Show tunnel URLssection (diff@@ -213,6 +213,21 @@). Surrounding page renders correctly. (The new section itself is not on the deployed site yet, since the PR is unmerged.)
Carried-forward render validation: the added 15-line section is byte-identical to the revision I fully rendered locally in my prior review (head 90f0d1e, served via pnpm dev + Playwright at http://localhost:4321/). That doc-tester run is reproduced verbatim below; its findings still apply unchanged because the section content did not change (only a rebase + base retarget occurred).
Documentation Test Report
Focus Area: PR #1492 Dev Tunnels "Show tunnel URLs" subsection
Served Base URL:http://localhost:4321/
Served Head SHA:90f0d1e38028a08857cb064929f55bb78e798512(content identical to currentb8fca591)Routes Exercised:
http://localhost:4321/integrations/devtools/dev-tunnels/http://localhost:4321/integrations/devtools/dev-tunnels/#show-tunnel-urlsSummary
Category Passed Failed Warnings Content Accuracy 4 0 0 Code Examples 0 0 0 CLI Commands 0 0 0 Links 2 0 0 Critical Issues
None.
Warnings
None.
Passed Checks
- The Dev Tunnels page loaded successfully.
- The "Show tunnel URLs" subsection appears in the "On this page" navigation.
- Clicking "Show tunnel URLs" navigated to
#show-tunnel-urls.- The subsection rendered in the expected position before "Service discovery integration."
- The intro paragraph clearly explains the highlighted dashboard properties.
- The highlighted Show tunnel URLs command text rendered clearly.
- The bulleted list rendered with bold labels for Tunnel URL, Inspect URL, and Local endpoint URL.
- The em dash rendered correctly as
—.- The "dev tunnels inspect" external link rendered with href
https://learn.microsoft.com/azure/developer/dev-tunnels/inspect-tunneling-http-requests.- The Note callout rendered correctly and explains the command enablement condition.
- No broken anchor, duplicate content, or formatting issue was observed in the tested section.
Recommendations
- Priority fixes: None.
- Documentation gaps: None found in the tested section.
- Product issues: None discovered from blind documentation testing.
Knowledge Gaps
None.
Verdict: COMMENT — every non-narrative claim now verified against microsoft/aspire main (the retarget to pre/13.6 resolved the previous release/13.5 mismatch), and the rendered section is clean. The only open item is the non-blocking branch-matching confirmation above (that pre/13.6 is the docs branch shipping the 13.6 release that carries show-tunnel-urls).
Automated docs-accuracy reviewer · head b8fca591da4d0a370d13239b455199407011676b · Phase A read microsoft/aspire@main (ac4f6515aef75c36ddb4f27a3addd7751591a84e; fallback — no pre/13.6/release/13.6 branch exists) · Phase B via doc-tester skill (deployed-page structural check + verbatim prior local render of identical content).
Documents changes from microsoft/aspire#16842
@maddymontaquilaTargeting
release/13.5— the latest release branch onmicrosoft/aspire.dev— becauserelease/13.6(from the source PR milestone13.6) does not exist there.Why
microsoft/aspire#16842 adds a highlighted Show tunnel URLs command to dev tunnel port resources, and publishes the tunnel, inspect, and local endpoint URLs as highlighted resource properties in the dashboard property pane. The existing Dev Tunnels integration doc didn't mention this discoverability feature.
What changed
src/frontend/src/content/docs/integrations/devtools/dev-tunnels.mdx: added a new Show tunnel URLs section (between "Service discovery integration" and its predecessor) describing:No new pages were created; only the existing
dev-tunnels.mdxpage was updated in place.